Artemis Appointment API
Reserve Appointment Overview
Once you've found a suitable supplier appointment date and slot, you need to reserve it
A successful reserve appointment request will return an appointment ID which should be included when you place your Product Order
On receiving the appointment ID, you will have a set time to associate the appointment ID with a Product Order. Set times per supplier are as follows:
Openreach - 24 hours
City Fibre - 12 hours
To reserve a supplier appointment, the following values are required:
Openreach FTTP
| HTTP Method | Key | Example Value(s) | Value Type | Validation |
|---|---|---|---|---|
| POST | billingAccount.id | "12345678" | string | Mandatory |
| POST | appointmentType | "Standard" | string | Mandatory |
| POST | productName | "C-OR-FTTP" | string | Mandatory |
| POST | productSpeed | "0.5/0.5", "40/10", "80/20", "115/20", "160/30", "220/30, "330/50", "550/75" or "1000/115" | string | Mandatory |
| POST | provisioningCommand | "ProvideNew", "Switch", "Takeover", "Restart", "SwitchToNew", "SwitchToStop" "ReplaceToNew or "ReplaceToStop" | string | Mandatory |
| POST | addressType | "GALK" | string | Mandatory |
| POST | galk | "A00031290370" | string | Mandatory |
| POST | districtCode | "ES" | string | Mandatory |
| POST | siteVisitReason | "Standard", "Premium", "Advanced" or "Prove IP Voice" | string | Mandatory |
| POST | appointmentFromDate | "2024-09-09" | string | Mandatory |
| POST | appointmentTimeSlot | "AM" or "PM" | string | Mandatory |
| POST | appointmentStartTime | "08:00" or "13:00" | string | Mandatory |
| POST | appointmentEndTime | "13:00 or "18:00" | string | Mandatory |
City Fibre FTTP
| HTTP Method | Key | Example Value(s) | Value Type | Validation |
|---|---|---|---|---|
| POST | billingAccount.id | "12345678" | string | Mandatory |
| POST | appointmentType | "Standard" | string | Mandatory |
| POST | productName | "C-CFH-FTTP" | string | Mandatory |
| POST | productSpeed | "0.5/0.5", "40/10", "80/20", "115/20", "160/30", "220/30, "330/50", "550/75" or "1000/115" | string | Mandatory |
| POST | provisioningCommand | "ProvideNew" | string | Mandatory |
| POST | addressType | "UPRN" | string | Mandatory |
| POST | uprn | "117084194" | string | Mandatory |
| POST | appointmentFromDate | "2024-09-09" | string | Mandatory |
| POST | appointmentTimeSlot | "AM" or "PM" | string | Mandatory |
| POST | appointmentStartTime | "08:00" or "13:00" | string | Mandatory |
| POST | appointmentEndTime | "13:00 or "18:00" | string | Mandatory |
Openreach SOGEA
| HTTP Method | Key | Example Value(s) | Value Type | Validation |
|---|---|---|---|---|
| POST | billingAccount.id | "12345678" | string | Mandatory |
| POST | appointmentType | "Standard" or "Flexible" | string | Mandatory |
| POST | productName | "C-OR-SOGEA" | string | Mandatory |
| POST | productSpeed | "0.5/0.5", "40/10" or "80/20" | string | Mandatory |
| POST | provisioningCommand | "ProvideNew", "Switch", "Takeover", "Restart", or "Replace" | string | Mandatory |
| POST | addressType | "GALK" | string | Mandatory |
| POST | galk | "A00031290370" | string | Mandatory |
| POST | districtCode | "ES" | string | Mandatory |
| POST | siteVisitReason | "Standard", "Premium", "Advanced", "Prove IP Voice" or No Site Visit" | string | Mandatory |
| POST | appointmentFromDate | "2024-09-09" | string | Mandatory |
| POST | appointmentTimeSlot | "AM" or "PM" | string | Mandatory |
| POST | appointmentStartTime | "08:00" or "13:00" | string | Mandatory |
| POST | appointmentEndTime | "13:00 or "18:00" | string | Mandatory |
On receiving the response payload you will be returned an supplierAppointmentId which will be used in the Product Order. The payload also includes a date and time or when the appointment is valid until:
{
"supplierAppointmentId": "12345",
"reservationValidUntil": "2023-02-07T21:49:09Z"
}